feat(linux): Add standby mode docs for AM62L#656
feat(linux): Add standby mode docs for AM62L#656ti-scaria wants to merge 1 commit intoTexasInstruments:masterfrom
Conversation
Introduce standby mode in AM62L and how it is used. Extending the CPUidle documentation for AM62L. Signed-off-by: Scaria Kochidanadu <s-kochidanadu@ti.com>
|
New warnings found with rstcheck: |
praneethbajjuri
left a comment
There was a problem hiding this comment.
bunch of issues with text format . Review and address vale comments as well
|
|
||
| ######################## | ||
| AM62L Standby Mode | ||
| ######################## |
There was a problem hiding this comment.
Reduce this "#####" till the text
|
|
||
| ***************************** | ||
| Standby Mode: Opportunistic | ||
| ***************************** |
|
|
||
| ***************************** | ||
| Idle States Supported | ||
| ***************************** |
|
|
||
| **************************** | ||
| Critical Prerequisites | ||
| **************************** |
|
|
||
| **************************** | ||
| Power Sequencing and Cluster Standby Entry/Exit | ||
| **************************** |
kwillis01
left a comment
There was a problem hiding this comment.
One other consideration is whether the pm_am62l_standby.rst page will be used by future SoCs, however the references to only AM62L should be good for now, just might have to be updated in the future.
| AM62L Standby Mode | ||
| ######################## | ||
|
|
||
| **Overview** |
There was a problem hiding this comment.
IMO remove, this is not really needed
| * **Automatic Operation**: No user configuration required; the system makes power decisions in real-time | ||
| * **Transparent**: Happens silently in the background during normal idle periods | ||
| * **Fast Response**: Minimal latency to wake up from idle state upon interrupt | ||
| * **Hierarchical Power Management**: Extends from individual CPU idle states to cluster-level standby |
There was a problem hiding this comment.
This may need more explanation, I am not sure if this is clear what this means to someone who is not familiar with standby
| automatically adjusts clock frequencies, disables non-critical power domains, and enables DDR auto-self-refresh | ||
| when all cores are idle, then quickly restores full operational state when needed. |
There was a problem hiding this comment.
Lines 12-13 kind of say the same thing. Might want to think about if you're repeating the same info and how to fix it so its not duplicate if possible
|
|
||
| **CPSW (Gigabit Ethernet) Driver Suspension** | ||
|
|
||
| The entry into Cluster level standby is conditioned on CPSW driver being suspended, since hardware CRC errors |
There was a problem hiding this comment.
s/conditioned/conditional
| The entry into Cluster level standby is conditioned on CPSW driver being suspended, since hardware CRC errors | ||
| occur when CPSW continues operation during cluster standby. The CPSW is an Always-On IP in the AM62L SoC. | ||
| For cluster standby mode to be entered safely, the CPSW driver must be suspended/disabled. This is handled | ||
| in the device tree overlay by disabling CPSW during standby transitions. |
There was a problem hiding this comment.
Remove the sentence about it being handled by the overlay since that is in the warning section below and CPSW is disabled completely
| idle transitions and hardware stability. | ||
|
|
||
| **************************** | ||
| Device Tree Configuration |
There was a problem hiding this comment.
IMO this section isn't needed because in the Idle States Supported section, this information is covered. If anything you can merge that info there so it is not separated. I don't think you need an example structure since the user can go look at the overlay themselves.
| is being actively used during idle periods. | ||
|
|
||
| **************************** | ||
| Power Consumption Expectations |
There was a problem hiding this comment.
IMO this section should be removed and the power measurements should be updated every cycle in the Linux performance section where the other low power mode measurements are.
| - :file:`plat/ti/k3/common/k3_psci.c` - PSCI implementation for K3 platforms | ||
| .. ifconfig:: CONFIG_part_variant in ('AM62X', 'AM62AX', 'AM62PX', 'J722S') | ||
|
|
||
| - :file:`plat/ti/k3/common/k3_psci.c` - PSCI implementation for K3 platforms |
There was a problem hiding this comment.
RST is very whitespace focused. 3 spaces is the current standard. This allows code sections to clearly line up with directive
| can be used as a reference. | ||
|
|
||
| .. ifconfig:: CONFIG_part_variant in ('AM62LX') | ||
|
|
There was a problem hiding this comment.
Content should be in line with the directive
| @@ -0,0 +1,354 @@ | |||
| .. _am62l_standby_mode: | |||
|
|
|||
| ######################## | |||
There was a problem hiding this comment.
Introduce standby mode in AM62L and how it is used.
Extending the CPUidle documentation for AM62L.